New validation notebook: Validate an application scorecard model#338
New validation notebook: Validate an application scorecard model#338
Conversation
|
@MichaelIngvarRoenning Sorry for the delay, I've been heads down on updating some other training stuff & redesign for our homepage. To keep you updated while I make some changes:
Agreed, I will give these introductory concepts another edit to make them more tailored to model validation. EDIT: Done!
Will do, I will massage the messaging around this. EDIT: Done!
Got it, we are reproducing the steps the model developer WOULD have taken to see if they were done correctly, not just mimicking, correct? EDIT: Done!
Made sure any sections referencing why we do this are clear etc.:
Same comment here as mentioned in Slack — unfortunately each notebook are "isolated" environments, so certain functions/inputs/outputs need to be rerun in order to be accessed. If you comment out those sections it won't work — very frustrating, I know, but I ran into this in the last series. It's just quirk of Jupyter Notebooks unfortunately.
I would like to keep it as is — the reason is we are structuring our updated training around this breakdown and it also matches the development introductory experience. e.g.
I think that once I clean up 111 to be more validator focused it will make more sense like this though!
Can you provide an example here of how you might structure it? I broke them down as best I could but I don't know enough about which tests are valuable to make a call. |
MichaelIngvarRoenning
left a comment
There was a problem hiding this comment.
Everything looks excellent!
PR SummaryThis pull request introduces a new Jupyter notebook for validating an application scorecard model using the ValidMind Library. The notebook provides a comprehensive guide for assessing the model's development through testing and analysis, including the use of challenger models for benchmarking performance. Key features of the notebook include:
Additionally, the PR updates multiple documentation references across various notebooks to include information about running tests and accessing the Python Library API reference. It also updates the The version of the ValidMind Library is incremented from 2.8.13 to 2.8.14. Test Suggestions
|






Internal Notes for Reviewers
Validate an application scorecard model
I edited Michael's draft notebook into a comprehensive model validation with the ValidMind Library experience: Validate an application scorecard model
Major stuff I modified in addition to the storytelling:
test_configcode as we were calling functions we weren't using,xgb_modelshould have beenxgb_model_developer_championetc.Other notes
.gitignoreHad to add the model pickle file here as an exception so that users can access it:
validmind-library/.gitignore
Line 194 in 72596a0
Add context to LLM-generated test descriptions
Just added a quick adjustment to include wording about session-locked custom context:
validmind-library/notebooks/how_to/add_context_to_llm_descriptions.ipynb
Line 379 in 09a348b
New to ValidMind?
I generalized the language in this templated section for all of our notebooks as the "Developer" portal now has much more than that — hopefully this new wording is more inclusive and descriptive as to what we hope that section will be:
validmind-library/notebooks/templates/about-validmind.ipynb
Line 34 in 09a348b
ValidMind for model validation
This got moved to a new Story: sc-9378
This notebook series will be a simpler version of what we cover in this extensive notebook, focusing on validating the customer churn/binary classification model instead and include some more basics like previewing the template, adding the results to your documentation, etc.
External Release Notes
Learn how to independently assess an application scorecard model as a validator with our new Validate an application scorecard model Jupyter Notebook. You'll use ValidMind to evaluate the development of a model by conducting thorough testing and analysis, including the use of challenger models to benchmark performance.
This interactive notebook provides a step-by-step guide for: